home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIHttpAuthManager.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  5.1 KB  |  132 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is Mozilla.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Sun Microsystem.
  19.  * Portions created by the Initial Developer are Copyright (C) 2003
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Darin Fisher <darin@meer.net>
  24.  *   Louie Zhao <louie.zhao@sun.com>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39.  
  40. #include "nsISupports.idl"
  41.  
  42. /**
  43.  * nsIHttpAuthManager
  44.  *
  45.  * This service provides access to cached HTTP authentication 
  46.  * user credentials (domain, username, password) for sites
  47.  * visited during the current browser session.
  48.  *
  49.  * This interface exists to provide other HTTP stacks with the
  50.  * ability to share HTTP authentication credentials with Necko.
  51.  * This is currently used by the Java plugin (version 1.5 and
  52.  * higher) to avoid duplicate authentication prompts when the
  53.  * Java client fetches content from a HTTP site that the user
  54.  * has already logged into.
  55.  */
  56. [scriptable, uuid(7ce8e9d1-8b4b-4883-a307-66fe12a50153)]
  57. interface nsIHttpAuthManager : nsISupports
  58. {
  59.     /**
  60.      * Lookup auth identity.
  61.      *
  62.      * @param aScheme
  63.      *        the URL scheme (e.g., "http").  NOTE: for proxy authentication,
  64.      *        this should be "http" (this includes authentication for SSL
  65.      *        tunneling).
  66.      * @param aHost
  67.      *        the host of the server issuing a challenge (ASCII only).
  68.      * @param aPort
  69.      *        the port of the server issuing a challenge.
  70.      * @param aAuthType
  71.      *        optional string identifying auth type used (e.g., "basic")
  72.      * @param aRealm
  73.      *        optional string identifying auth realm.
  74.      * @param aPath
  75.      *        optional string identifying auth path. empty for proxy auth.
  76.      * @param aUserDomain
  77.      *        return value containing user domain.
  78.      * @param aUserName
  79.      *        return value containing user name.
  80.      * @param aUserPassword
  81.      *        return value containing user password.
  82.      */
  83.     void getAuthIdentity(in ACString aScheme,
  84.                          in ACString aHost,
  85.                          in PRInt32  aPort,
  86.                          in ACString aAuthType,
  87.                          in ACString aRealm,
  88.                          in ACString aPath,
  89.                          out AString aUserDomain,
  90.                          out AString aUserName,
  91.                          out AString aUserPassword);
  92.  
  93.     /**
  94.      * Store auth identity.
  95.      *
  96.      * @param aScheme
  97.      *        the URL scheme (e.g., "http").  NOTE: for proxy authentication,
  98.      *        this should be "http" (this includes authentication for SSL
  99.      *        tunneling).
  100.      * @param aHost
  101.      *        the host of the server issuing a challenge (ASCII only).
  102.      * @param aPort
  103.      *        the port of the server issuing a challenge.
  104.      * @param aAuthType
  105.      *        optional string identifying auth type used (e.g., "basic")
  106.      * @param aRealm
  107.      *        optional string identifying auth realm.
  108.      * @param aPath
  109.      *        optional string identifying auth path. empty for proxy auth.
  110.      * @param aUserDomain
  111.      *        optional string containing user domain.
  112.      * @param aUserName
  113.      *        optional string containing user name.
  114.      * @param aUserPassword
  115.      *        optional string containing user password.
  116.      */
  117.     void setAuthIdentity(in ACString aScheme,
  118.                          in ACString aHost,
  119.                          in PRInt32  aPort,
  120.                          in ACString aAuthType,
  121.                          in ACString aRealm,
  122.                          in ACString aPath,
  123.                          in AString  aUserDomain,
  124.                          in AString  aUserName,
  125.                          in AString  aUserPassword);
  126.  
  127.     /**
  128.      * Clear all auth cache.
  129.      */
  130.     void clearAll();
  131. };
  132.